WOLF core
WOLF: A Modular Estimation Framework for Robotics
XXXXXXXXXXXXXXXXXXXXXXXXvoid(0)" frameborder="0" name="MSearchResults" id="MSearchResults">
wolf::HardwareBase Class Reference

#include <core/hardware/hardware_base.h>

Inheritance diagram for wolf::HardwareBase:
[legend]

Public Member Functions

 HardwareBase ()
 
 ~HardwareBase () override
 
bool hasChildren () const override
 
SensorBaseConstPtrList getSensorList () const
 
SensorBasePtrList getSensorList ()
 
SensorBaseConstPtr getSensor (const std::string &_sensor_name) const
 get a sensor pointer by its name More...
 
SensorBasePtr getSensor (const std::string &_sensor_name)
 
virtual void printHeader (int depth, bool factored_by, bool metric, bool state_blocks, std::ostream &stream, std::string _tabs="") const
 
void print (int depth, bool factored_by, bool metric, bool state_blocks, std::ostream &stream=std::cout, std::string _tabs="") const
 
virtual CheckLog localCheck (bool _verbose, std::ostream &_stream, std::string _tabs="") const
 
bool check (CheckLog &_log, bool _verbose, std::ostream &_stream, std::string _tabs="") const
 
- Public Member Functions inherited from wolf::NodeBase
 NodeBase (const std::string &_category, const std::string &_type="Undefined", const std::string &_name="")
 
virtual ~NodeBase ()=default
 
unsigned int nodeId () const
 
std::string getCategory () const
 
std::string getType () const
 
std::string getName () const
 
bool isRemoving () const
 
virtual bool hasChildren () const =0
 
void setType (const std::string &_type)
 
void setName (const std::string &_name)
 
ProblemConstPtr getProblem () const
 
ProblemPtr getProblem ()
 

Additional Inherited Members

- Protected Member Functions inherited from wolf::NodeBase
virtual void setProblem (ProblemPtr _prob_ptr)
 
- Protected Attributes inherited from wolf::NodeBase
ProblemWPtr problem_ptr_
 
unsigned int node_id_
 Node id. It is unique over the whole Wolf Tree. More...
 
std::string node_category_
 Text label identifying the category of node ("SENSOR", "FEATURE", etc) More...
 
std::string node_type_
 Text label identifying the type or subcategory of node ("Pin Hole", "Point 2d", etc) More...
 
std::string node_name_
 
bool is_removing_
 A flag for safely removing nodes from the Wolf tree. See remove(). More...
 

Constructor & Destructor Documentation

◆ HardwareBase()

wolf::HardwareBase::HardwareBase ( )

◆ ~HardwareBase()

wolf::HardwareBase::~HardwareBase ( )
override

Member Function Documentation

◆ check()

bool wolf::HardwareBase::check ( CheckLog &  _log,
bool  _verbose,
std::ostream &  _stream,
std::string  _tabs = "" 
) const

◆ getSensor() [1/2]

SensorBasePtr wolf::HardwareBase::getSensor ( const std::string &  _sensor_name)

◆ getSensor() [2/2]

SensorBaseConstPtr wolf::HardwareBase::getSensor ( const std::string &  _sensor_name) const

get a sensor pointer by its name

Parameters
_sensor_nameThe sensor name, as it was installed with installSensor()

◆ getSensorList() [1/2]

SensorBasePtrList wolf::HardwareBase::getSensorList ( )
inline

◆ getSensorList() [2/2]

SensorBaseConstPtrList wolf::HardwareBase::getSensorList ( ) const
inline

◆ hasChildren()

bool wolf::HardwareBase::hasChildren ( ) const
inlineoverridevirtual

Implements wolf::NodeBase.

◆ localCheck()

CheckLog wolf::HardwareBase::localCheck ( bool  _verbose,
std::ostream &  _stream,
std::string  _tabs = "" 
) const
virtual

◆ print()

void wolf::HardwareBase::print ( int  depth,
bool  factored_by,
bool  metric,
bool  state_blocks,
std::ostream &  stream = std::cout,
std::string  _tabs = "" 
) const

◆ printHeader()

void wolf::HardwareBase::printHeader ( int  depth,
bool  factored_by,
bool  metric,
bool  state_blocks,
std::ostream &  stream,
std::string  _tabs = "" 
) const
virtual

The documentation for this class was generated from the following files: